Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[dev docs] Add sample data tutorial. Closes #98297 #99252

Merged
merged 11 commits into from
May 18, 2021
Merged

[dev docs] Add sample data tutorial. Closes #98297 #99252

merged 11 commits into from
May 18, 2021

Conversation

jbudz
Copy link
Member

@jbudz jbudz commented May 4, 2021 •
edited
Loading

This adds a tutorial for adding sample data to the developer documentation.

Based on https://www.elastic.co/guide/en/kibana/master/sample-data.html

@jbudz jbudz added Team:Operations Team label for Operations Team v8.0.0 release_note:skip Skip the PR/issue when compiling release notes docs DevDocs v7.14.0 labels May 4, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-operations (Team:Operations)

@jbudz
Copy link
Member Author

jbudz commented May 4, 2021

@stacey-gammon should the original tutorial be removed?

@stacey-gammon
Copy link
Contributor

Awesome!

I wouldn't remove it because the new dev docs are still private and the current tutorial is public. I think we should leave our entire asciidoc dev docs in a legacy state, maintenance-only mode, for the time being.

@tylersmalley
Copy link
Contributor

LGTM, not sure how to verify the formatting.

@jbudz
Copy link
Member Author

jbudz commented May 6, 2021

@elasticmachine merge upstream

@jbudz
Copy link
Member Author

jbudz commented May 10, 2021

@elasticmachine merge upstream

@jbudz
Copy link
Member Author

jbudz commented May 10, 2021

@elasticmachine merge upstream

gchaps
gchaps reviewed May 13, 2021
View reviewed changes
dev_docs/tutorials/sample_data.mdx Outdated

## Installation from the UI

1) Navigate to the home page
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use "1." instead of "1)". Also, add an ending period to each step.

  1. Navigate to the home page.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pushed with c98f1d5

dev_docs/tutorials/sample_data.mdx Outdated
## Installation from the UI

1) Navigate to the home page
1) Click "Add data"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For UI components, we use bold instead of quotes:

  1. Click Add data.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pushed with c98f1d5

@jbudz
Copy link
Member Author

jbudz commented May 18, 2021

@elasticmachine merge upstream

gchaps
gchaps approved these changes May 18, 2021
View reviewed changes
Copy link
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with addition of ending period in numbered steps.

dev_docs/tutorials/sample_data.mdx Outdated

## Installation from the UI

1. Navigate to the home page
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a period after the end of each step both here and in the following section.

Navigate to the home page.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Pushed with 60ff315.

@jbudz jbudz enabled auto-merge (squash) May 18, 2021 20:51
@jbudz jbudz added the auto-backport Deprecated - use backport:version if exact versions are needed label May 18, 2021
@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Unknown metric groups

References to deprecated APIs

id before after diff
canvas 29 25 -4
crossClusterReplication 8 6 -2
fleet 22 20 -2
globalSearch 4 2 -2
indexManagement 12 7 -5
infra 261 149 -112
lens 67 45 -22
licensing 18 15 -3
maps 286 208 -78
ml 121 115 -6
monitoring 109 56 -53
stackAlerts 101 95 -6
total -295

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@jbudz jbudz merged commit e476029 into elastic:master May 18, 2021
kibanamachine added a commit to kibanamachine/kibana that referenced this pull request May 18, 2021
@jbudz @kibanamachine
[dev docs] Add sample data tutorial. Closes elastic#98297 (elastic#99252
1436d34 
)

Co-authored-by: Kibana Machine <[email protected]>
@kibanamachine kibanamachine mentioned this pull request May 18, 2021
Merged
@kibanamachine
Copy link
Contributor

💚 Backport successful

Status Branch Result
✅ 7.x

This backport PR will be merged automatically after passing CI.

kibanamachine added a commit that referenced this pull request May 19, 2021
@kibanamachine @jbudz
[dev docs] Add sample data tutorial. Closes #98297 (#99252) (#100308)
c85ccf9 
Co-authored-by: Kibana Machine <[email protected]>

Co-authored-by: Jonathan Budzenski <[email protected]>
yctercero pushed a commit to yctercero/kibana that referenced this pull request May 25, 2021
@jbudz @kibanamachine @yctercero
[dev docs] Add sample data tutorial. Closes elastic#98297 (elastic#99252
f85e37c 
)

Co-authored-by: Kibana Machine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gchaps gchaps gchaps approved these changes

@tylersmalley tylersmalley tylersmalley approved these changes

Assignees
No one assigned
Labels
auto-backport Deprecated - use backport:version if exact versions are needed DevDocs docs release_note:skip Skip the PR/issue when compiling release notes Team:Operations Team label for Operations Team v7.14.0 v8.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@jbudz @elasticmachine @stacey-gammon @tylersmalley @kibanamachine @gchaps